home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / README < prev    next >
Encoding:
Text File  |  2004-03-24  |  9.0 KB  |  207 lines
  1. $Id: README,v 1.49.2.4 2003/07/30 00:39:37 CelloG Exp $
  2.  
  3. ################################################################################
  4.                 phpDocumentor
  5.  
  6. ################################################################################
  7. Installation
  8. ################################################################################
  9.  
  10. Installation for phpDocumentor is as simple as installing PHP and a web server.
  11. If you need help installing a webserver or php, refer to the documentation that
  12. comes with the webserver or with php.
  13.  
  14. All users with PEAR should either install this version directly from the package.xml
  15. file included in the distribution, or install via pear install PhpDocumentor.  The
  16. command-line interface "phpdoc" will be in the path, you can use it immediately
  17. on both windows and unix.  The web interface will be in a subdirectory of your
  18. document root, as soon as PEAR releases a version with support for the role="publicweb"
  19. attribute.  Be sure to "pear config-set publicweb_dir /path/to/my/htdocs"
  20.  
  21. To use phpDocumentor as a command-line
  22. tool in *nix-based systems, simply run the phpdoc script.  In windows, run
  23. "c:\php\php.exe phpdoc" where C:\php is the path to the cgi version of php.
  24. The phpdoc command-line interface will not run with the ISAPI module of PHP.
  25. To see the command line options, use phpdoc -h or read at the bottom of this
  26. README.
  27.  
  28. There is a BASH shell script that you can put inside your project that can save
  29. time writing command-line options of phpdoc. Simply copy makedoc.sh to your
  30. project path and edit it. When you wish to rebuild the documentation, run it again. 
  31.  
  32. To use phpDocumentor's web interface, install the files into a subdirectory of
  33. your document root (read the webserver's documentation for more information if you
  34. don't understand how to install into a subdirectory of your document root).
  35. Then, browse to the web page as you would to any other web page.  If you encounter
  36. problems, make sure that the web server has write access permissions to the output
  37. directory that you choose.  Again, your web server documentation has detailed
  38. information on how to do this.  The command-line interface will not have problems
  39. with access.
  40.  
  41. If you need more detailed help, check out INSTALL
  42.  
  43. ################################################################################
  44. Release Notes
  45. ################################################################################
  46.  
  47. Release notes for the newest version are in Release-1.2.2
  48.  
  49. 1.2.2 is out, a STABLE bugfix release
  50.  
  51. To learn howto write PHPDoc-style documentation run phpDocumentor on itself, with
  52. ./phpdoc -c makedocs.  Before you do, modify users/makedocs.ini to contain the
  53. proper path values
  54.  
  55. If you find a bug please post it at:
  56. http://sourceforge.net/tracker/?func=add&group_id=11194&atid=111194
  57.  
  58. ################################################################################
  59. General Notes
  60. ################################################################################
  61. phpDocumentor is hosted at phpdoc.org, with downloads and mailing list through 
  62. sourceforge.net
  63.  
  64. webpage:     http://phpdoc.org/
  65. documentation:      http://phpdoc.org/manual.php
  66. mirror:     http://phpdocu.sourceforge.net
  67. projectpage:     http://sourceforge.net/projects/phpdocu
  68.  
  69. For a list of people who have helped work on this project please read the 
  70. Authors file
  71.  
  72. phpDocumentor 1.2.2 is released under the PHP License version 3.0, text is in
  73. PHPLICENSE.txt
  74.  
  75. ################################################################################
  76. Feature Notes
  77. ################################################################################
  78.  
  79. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  80. written in PHP.  It is the most versatile tool for documenting PHP.
  81.  
  82. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  83. and intermediary data structures that allow it to perform at a level other
  84. automatic documentors for PHP cannot achieve:
  85.   --parsing any php file, with multiple classes and functions in the same file
  86.   --fully compliant with even the most esoteric php syntax 
  87.       ($string = <<< EOF, for example)
  88.   --ability to generate multiple output formats
  89.   --extremely fast parsing
  90.   --error/warnings by line number and file to allow for debugging of
  91.     documentation tags
  92.   --multiple output templates to easily customize the look of generated
  93.     documentation
  94.   --extensive documentation of the package, including a detailed specification
  95.     for tags and templates
  96.   --PHP License
  97.   
  98. New in version 1.2.2:
  99.   --PDF converter is stable
  100.   --CHM converter is stable
  101.   --XML:DocBook/peardoc2 is stable
  102.   
  103. New in version 1.2:
  104.   --tutorials: user-level documentation can be linked to from API documentation,
  105.     including at the sub-section level.
  106.   --Completely re-worked manual at http://www.phpdoc.org/docs
  107.   --HTML:default has been replaced by HTML:frames, and all of the templates
  108.     overhauled by Marco von Ballmoos.  Several new templates are available
  109.   --XML:DocBook/peardoc2 converter for PEAR authors
  110.   --PDF converter is beta
  111.   --CHM converter is beta
  112.   --much more stable than version 1.1
  113.   --source code highlighting and cross-referencing
  114.   --many new features, see the manual
  115.  
  116. If something is missing from this list make sure sure to file
  117. a feature request on sourceforge
  118.  
  119. http://sourceforge.net/tracker/?func=add&group_id=11194&atid=361194
  120.  
  121. If you want to help code that new feature and get it just right, please let us know.
  122. Any help is greatly appreciated, just contact the 
  123. phpDocumentor team for information on getting started.
  124.  
  125. phpDocumentor needs php 4.1.0 or greater, but you'll see the best performance
  126. in the newest version.  The recommended version for 1.2.0rc2 is 4.3.0+.
  127. Performance is at least 30-50% faster with PHP 4.3.0
  128.  
  129. ################################################################################
  130. Command Line notes
  131. ################################################################################
  132.  
  133. Read the documentation at http://www.phpdoc.org/docs for the most up-to-date
  134. command-line information.
  135.  
  136. You can also generate documentation from the source using:
  137.  
  138. phpdoc -c makedocs
  139.  
  140. run this command from the installation directory, and make sure you have full
  141. write and directory creation permissions or it will not work
  142.  
  143. Generated documentation is accessible via Documentation/new/index.html
  144.  
  145. ################################################################################
  146.  
  147. if you run phpdoc and get :
  148. bash: ./phpdoc: No such file or directory
  149.  
  150. Then you haven't installed the cgi version of php
  151. goto your php src dir and try
  152. make clean
  153. ./configure
  154. make
  155. make install
  156.  
  157. phpdoc should work now
  158.  
  159. If your using php 4.2.0 or higher you will want to use the cli version
  160. instead of the cgi.  Checkout php.net for details on these changes
  161.  
  162.  
  163. ################################################################################
  164. Web Interface notes
  165. ################################################################################
  166. Put phpdoc.php together with the *.inc files someplace on your webserver.
  167. NEVER USE THE WEB INTERFACE ON A PRODUCTION WEBSERVER.  Allowing your server
  168. to write files to disk is a serious security risk, and phpDocumentor is not
  169. designed to work on insecure systems.  Setup php on a development machine
  170. that has a firewall or no internet connection, and run phpDocumentor from there.
  171.  
  172. Make sure you webserver can write to where ever you specify as a target or you
  173. will get lots of errors
  174.  
  175. ################################################################################
  176. Thanks
  177. ################################################################################
  178. Thanks to Sam Blum for his assistance with @example and other enhancements
  179. Thanks to William K. Hardeman for his HTML:Smarty:HandS design
  180. Thanks to Marco von Ballmoos for transforming the HTML:frames converter and
  181.     templates into a magnificent work of art
  182. Thanks to Andrew Eddie for docbuilder and the CHM Converter enhancements
  183. Thanks to Darren Cook for suggesting exciting new features, and making sure that
  184.     they worked when implemented
  185. Thanks to Marko Kaening, Dan Convissor for policing the source and finding bugs
  186.     that would have otherwise gone undetected
  187. Thanks to Juan Pablo Morales for the web interface.
  188. Thanks to whoever sent me the patch to make phpdocumentor work better in NT
  189.     I have your diff and patched the program but i seem to have lost your
  190.     name if you send it to me i'll add it to the Authors file
  191. Thanks to Florian Clever for the newest set of win32 patches they seem to have
  192.     fixed the last of the problems.
  193.     
  194.     Thanks to EVERYONE who has provided ideas and input, without you,
  195.                      phpDocumentor would be nothing
  196.  
  197. ################################################################################
  198. ################################################################################
  199. if you have any questions please email
  200. joshua eichorn jeichorn@phpdoc.org
  201. gregory beaver cellog@users.sourceforge.net
  202.  
  203.  
  204.  
  205.  
  206. vim: set expandtab: 
  207.